Expand description
A crate that provides abi-safe and stable wrappers of language and library constructs that don’t have fixed abi This provides shims for otherwise unusable constructs that can validly be passed accross ABI bounderies. All publically exposed types in this api have a stable layout and abi, that may only change on semver major versions Thus, it is valid to use these types accross versions
Interface
This crate relies on a number of special symbols, provided by an interface library, which is typically a cdylib (so that there is one copy at runtime).
This interface is typically provided by the xlang_interface
crate (which is linked by using the xlang
crate), otherwise, it must be provided and linked separately.
The symbols that this crate expects the interface library to provide are considered unstable, but all start with either the xlang_
or XLANG_
prefix.
The symbols are publically available in the module that makes primary of them.
The current list is:
Modules
std::boxed::Box
that uses the alloc::Allocator
trait, and is ABI safe for all allocatorsalloc::Allocator
trait and that have Stable ABItraits::DynRef
(et. al)std::option::Option
for all types.xlang_abi
std::result::Result
.&[T]
and &mut [T]
std::string::String
that uses alloc::Allocator
, and is ABI safe.
Also defines an ABI safe equivalent for &str
(but not &mut str
)std::string::String
that uses alloc::Allocator
, and is ABI safe.Macros
StringView
in a constant context.
This is equivalent to StringView::new(str)
, except it is valid in a const initializerstd::format
that returns a String
"rustcall"
abi.
This abi matches the ABI used by lcrust v0 for extern "Rust"
functions, without #[track_caller]
support.
See The LCRust v0 ABI for details on the interface.?
operator for xlang_abi
typesvec
containing the given elements.